Skip to main content

SHIELDEX Integration Guide

This document describes the process of integrating the SHIELDEX File neutralization system.

The integration method is largelyCallback methodandPolling methodSupports two things.

1. Overall Integration Process​

Decontamination linkage isAPI Key issuance → De-identification request → Check results → Download fileIt will proceed in 4 steps.

Step 1. Decontamination Request​

Transfer files to the SHIELDEX server in the integration system to register a job and receive a Job ID.

Step 2. Check Results​

Check the completion status of the decontamination work. You can choose one of two methods.

The server notifies the integrated system of the results upon completion of the task.

Type B: Status Check (Polling)​

The integration system periodically queries the server for status to confirm completion.

Step 3. File Download​

Download the file once the demilitarization is successfully completed.

2. Select Integration Method​

When requesting decontaminationcallbackURLIf you include it, you will be notified of the results at the corresponding URL as soon as the processing is completed.

  • Advantages: There are no unnecessary query requests, and real-time performance is guaranteed.
  • condition: There must be an API server on the integration system side that can receive results.

Type B: Polling Method​

After the decontamination request, periodicallyStatus Inquiry APIis a method to check the completion status by calling.

  • Advantages: It can be implemented without a separate receiving server in the integration system.
  • Caution: Too frequent requests (less than 200ms) can cause server load.

3. Step-by-step Detailed Guide​

Step 0. API Key Issuance (Preparation)​

To call the decontamination API, you must first register the integration system and obtain an API Key.

  1. Web Console →Policy → Integration System Policy → Integration System Registration
  2. Enter the integration system name and label, and then register.Automatic issuance of API KeyIt works.
  3. (Optional)Allowed IPRequests can only be made from the registered IP.
  4. The issued API Key is required for all de-identification API calls.Authorization: Bearer <API-KEY>Includes in the header.

Step 1. Declassification Request (Common)​

files and metadatamultipart/form-dataRegister the task by sending it to __PH_0__.

API KeyAuthorization: BearerIdentifies the integration system by including it in the header.

Step 2. Check Results​

A. Receiving Callback​

The JSON result arrives at the URL set upon request.

{
  "jobID": "test-job-001",
  "code": 0,
  "msg": "success",
  "logReason": 200000,
  "logReasonMsg": "파일 재구성 완료"
}

B. Status Check (Polling)​

Task completed(code: 0, 1, 2) Calls the API periodically until it becomes available.

Step 3. File Download​

Result Confirmation Stepcode: 0(success) orcode: 1(Exceptions/Original Import) In this case, download the file.

4. Precautions When Integrating​

  • UTF-8 Encoding: All character sets for requests must comply with UTF-8.
  • Download Timing: Status inquiry API response isComplete(code: 0, 1**)**You should only request a download when in a state.